First steps
Welcome!
Hello and welcome to the first step in integrating with Nursa! We’re excited that you are interested in leveraging our API to enhance your operations.The process is straightforward, and I'll guide you step by step through the entire flow.
Introductions
I'm Josh Bear, the Head of Integrations here at Nursa, and I’m thrilled to see you here. If you have any questions or run into any issues while setting up your integration, don’t hesitate to reach out to Piotr Klata (piotrek@nursa.com), our Product Manager in charge of the Nursa API team. We’re both here to ensure your integration experience is smooth and successful.
Let’s Meet!
We understand that every business model is unique, and we’re committed to finding the best common ground between our API functionality and your specific needs. I’d be happy to set up a meeting to discuss how we can tailor the integration to best suit your requirements. Send us a message with your availability and we will arrange for a meeting!
Integration Steps
Here’s a step-by-step guide to help you get started with the Nursa API:
1. Sign up as a Facility User
- You’ll need this account to register your first application in the sandbox environment.
- To do that please complete this flow: First Sign Up
2. Register the Application
- Register your application so we can understand and validate the requests coming from your system.
- You have your first user so now you can access our Developer Portal. Complete this flow: Register the application.
3. Get the Token
- First, we suggest exploring our most basic flow, which allows you to get the access token required to validate the requests.
- You can implement the basic flow by following this guide: Authorization flow.
4. Start the Facility Onboarding
- Next, you’ll need to connect to a Facility to post your first shift.
- There are two options to do this, see our [Facility Onboarding](/docs/Integration Guideline/Facility Onboarding) for full details.
5. Post Your First Shift
- Facilities post shifts to our Marketplace, which can then be viewed by a pool of qualified and credentialed clinicians in the area.
- You are almost there, pick the facility, choose what open shift you want to fill and Post the First Shift.
6. Check for Requests
- To schedule a clinician, you first must get requests for your shift. Check the shifts you posted to see if any requests have been submitted.
- Checking for requests can be automated by Webhooks but for now it will be more than enough if you check How to Get Requested Shifts.
7. Schedule a Clinician
- You may need more information about your scheduled clinician. You can Get the (optional) Clinician data here. The Clinician needs to know that you want them to come, Schedule Clinician for a Shift to let them know about your decision.
- A new clinician is interested in picking up a shift in your facility. Schedule them to let them know when and where they will work.
8. Review Clinician Shift Report
- After the clinician completes the shift, they will submit a Shift Report with their hours worked. Review and adjust this report as necessary to match your internal records.
- Depending on what you want to do, you will need to request different endpoints. Check the Shift Reports to get to the bottom of it!
9. Report Issues
- If there was an issue with the clinician, such as a no-show, you can report it through our system. We will handle the situation internally from there.
- Hopefully it will rarely happen but the [Cancelation guide](/docs/Integration Guideline/Cancellations) will help you build the right flow.
10. Optimize with Webhooks
- Constantly requesting the API may be sub-optimal. Instead, Set up Webhooks to receive important notifications in real-time, ensuring you never miss an update.
We hope this guide helps you get started smoothly. If you have any questions or need further assistance, please don't hesitate to reach out!
Best,
Josh Bear
Head of Integrations, Nursa